<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class QueryResult</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface QueryResult</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A QueryResult object. Returned in an iterator by <a href="../phpContentRepository/Query.html#methodexecute">Query::execute()</a></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_query_QueryResult_interface_php.html">/query/QueryResult.interface.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#getNode" title="details" class="method-name">getNode</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getNodePaths" title="details" class="method-name">getNodePaths</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">object|null</span>
										<a href="#getProperty" title="details" class="method-name">getProperty</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string|null</span>
										<a href="#getPropertyName" title="details" class="method-name">getPropertyName</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getScore" title="details" class="method-name">getScore</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string|null</span>
										<a href="#getUUID" title="details" class="method-name">getUUID</a>
										()
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetNode" id="getNode"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getNode</span> (line <span class="line-number">44</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a <a href="../phpContentRepository/Node.html">Node</a> meeting the search criteria.</p>
<p class="description"><p>If the query executed included a full text SEARCH clause then this method  returns the parent <a href="../phpContentRepository/Node.html">Node</a> of the <a href="../phpContentRepository/Property.html">Property</a> returned by  <a href="../phpContentRepository/QueryResult.html#methodgetProperty">getProperty()</a>.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			getNode
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetNodePaths" id="getNodePaths"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getNodePaths</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the paths (there may be more than one) of the matching  <a href="../phpContentRepository/Node.html">Node</a>.</p>
<p class="description"><p>This method may be used to avoid the overhead of accessing the matching  <a href="../phpContentRepository/Node.html">Node</a> itself, if only the paths are required.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <a href="../phpContentRepository/StringIterator.html">StringIterator</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getNodePaths
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetProperty" id="getProperty"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getProperty</span> (line <span class="line-number">82</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the matching <a href="../phpContentRepository/Property.html">Property</a> if the query executed included a  full text SEARCH clause that matched the <a href="../phpContentRepository/Property.html">Property</a>'s value.</p>
<p class="description"><p>If this method returns a <a href="../phpContentRepository/Property.html">Property</a>, then the <a href="../phpContentRepository/QueryResult.html#methodgetNode">getNode()</a>  method must return that <a href="../phpContentRepository/Property.html">Property</a>'s parent.</p><p>If the query did not include a SEARCH clause then this method returns  NULL.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object|null</span>
		<span class="method-name">
			getProperty
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetPropertyName" id="getPropertyName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getPropertyName</span> (line <span class="line-number">96</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name of a <a href="../phpContentRepository/Property.html">Property</a> retrieved by getProperty()</p>
<p class="description"><p>This method may be used to avoid the overhead of accessing the matching  property itself, if only the name is required.</p><p>If the query did not include a SEARCH clause then this method returns  NULL.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|null</span>
		<span class="method-name">
			getPropertyName
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetScore" id="getScore"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getScore</span> (line <span class="line-number">116</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The relevance of this QueryResult.</p>
<p class="description"><p>The details of this metric are implementation specific. The only  requirement is that the returned integer must be equal to or greater than  zero (i &gt;= 0) and that higher score number means &quot;more relevant&quot;.</p><p>Implementations that do not support this metric are free to return a  score of zero (0) for every <a href="../phpContentRepository/QueryResult.html">QueryResult</a>.</p><p>If the JCRQL clause ORDER BY SCORE was invoked (or a similar directive  in another language) then the QueryResultIterator returned by  <a href="../phpContentRepository/Query.html#methodexecute">Query::execute()</a> must order its returned <a href="../phpContentRepository/QueryResult.html">QueryResult</a>  objects accordingly, using this score value.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getScore
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetUUID" id="getUUID"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getUUID</span> (line <span class="line-number">67</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the UUID of the matching <a href="../phpContentRepository/Node.html">Node</a>.</p>
<p class="description"><p>If the <a href="../phpContentRepository/Node.html">Node</a> does not have a UUID, it returns NULL.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|null</span>
		<span class="method-name">
			getUUID
		</span>
				()
			</div>
	
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:21 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>